View Javadoc

1   /*
2    *******************************************************************************
3    * Copyright (c) 2005 Chris Rose and AIMedia
4    * All rights reserved. IValueList and the accompanying materials
5    * are made available under the terms of the Common Public License v1.0
6    * which accompanies this distribution, and is available at
7    * http://www.eclipse.org/legal/cpl-v10.html
8    * 
9    * Contributors:
10   *     Chris Rose
11   *******************************************************************************/
12  package com.aimedia.ui;
13  
14  import java.util.List;
15  
16  /***
17   * An interface to be implemented by a class that can make use of a list of
18   * <code>NutrientInfo</code> values.
19   *  
20   * @author Chris Rose
21   */
22  public interface IValueListUser {
23  
24      /***
25       * This method is to be called with a <code>List</code> containing nothing
26       * except <code>NutrientInfo</code> objects.  The implementing class can do
27       * more or less whatever it wants with them.
28       * 
29       * @param valueNames the <code>List</code> of <code>NutrientInfo</code> objects
30       * to be acted upon.
31       * @throws <code>ClassCastException</code> if any element in the list is not
32       * a <code>NutrientInfo</code> instance.
33       */
34      void setValueList(List valueNames);
35      
36  }